/* Alloy Analyzer 4 -- Copyright (c) 2006-2009, Felix Chang
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package edu.mit.csail.sdg.alloy4compiler.ast;

import java.awt.BorderLayout;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.util.ArrayList;
import java.util.List;
import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.border.EmptyBorder;
import edu.mit.csail.sdg.alloy4.ConstList;
import edu.mit.csail.sdg.alloy4.Listener;
import edu.mit.csail.sdg.alloy4.OurTree;
import edu.mit.csail.sdg.alloy4.Pos;
import edu.mit.csail.sdg.alloy4.Util;

/** This abstract class represents a node that can be browsed in the graphical parse tree viewer. */

public abstract class Browsable {

   /** Returns a Pos object representing the position of this Expr. */
   public Pos pos() { return Pos.UNKNOWN; }

   /** Returns a Pos object representing the entire span of this Expr and all its subexpressions. */
   public Pos span() { return pos(); }

   /** Returns the description to show for this node. */
   public abstract String getDescription();

   /** Returns a list of subnodes for this node. */
   public abstract List<? extends Browsable> getSubnodes();

   /** Construct a Browsable node with the given description and the given single subnode. */
   public static final Browsable make(final Pos pos, final Pos span, final String description, Browsable subnode) {
      return make(pos, span, description, Util.asList(subnode));
   }

   /** Construct a Browsable node with the given description and the given single subnode. */
   public static final Browsable make(final String description, Browsable subnode) {
      return make(Pos.UNKNOWN, Pos.UNKNOWN, description, Util.asList(subnode));
   }

   /** Construct a Browsable node with the given description and the given 0 or more subnodes. */
   public static final Browsable make(final String description, final List<? extends Browsable> subnodes) {
      return make(Pos.UNKNOWN, Pos.UNKNOWN, description, subnodes);
   }

   /** Construct a Browsable node with the given description and the given 0 or more subnodes. */
   public static final Browsable make(final Pos pos, final Pos span, final String description, final List<? extends Browsable> subnodes) {
      final ConstList<? extends Browsable> constlist = ConstList.make(subnodes);
      return new Browsable() {
         @Override public Pos pos() { return pos; }
         @Override public Pos span() { return span; }
         @Override public String getDescription() { return description; }
         @Override public List<? extends Browsable> getSubnodes() { return constlist; }
      };
   }

   /** Display this object (and so objects) as a tree; if listener!=null, it will receive OurTree.Event.SELECT events. */
   public final JFrame showAsTree(Listener listener) {
      final OurTree tree = new OurTree(12) {
         private static final long serialVersionUID = 0;
         private final boolean onWindows = Util.onWindows();
         {do_start();}
         @Override public String convertValueToText(Object val,boolean selected,boolean expanded,boolean leaf,int row,boolean focus) {
             String c = ">";
             String x = (val instanceof Browsable) ? ((Browsable)val).getDescription() : String.valueOf(val);
             if (onWindows) c = selected ? " style=\"color:#ffffff;\">" : " style=\"color:#000000;\">";
             return "<html> <span" + c + x + "</span></html>";
         }
         @Override public List<?> do_ask(Object parent) {
            if (parent instanceof Browsable) return ((Browsable)parent).getSubnodes(); else return new ArrayList<Browsable>();
         }
         @Override public Object do_root() { return Browsable.this; }
      };
      tree.setBorder(new EmptyBorder(3,3,3,3));
      final JScrollPane scr = new JScrollPane(tree, JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED, JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
      scr.addFocusListener(new FocusListener() {
         public void focusGained(FocusEvent e) { tree.requestFocusInWindow(); }
         public void focusLost(FocusEvent e) { }
      });
      final JFrame x = new JFrame("Parse Tree");
      x.setLayout(new BorderLayout());
      x.add(scr, BorderLayout.CENTER);
      x.pack();
      x.setSize(500, 500);
      x.setLocationRelativeTo(null);
      x.setVisible(true);
      if (listener!=null) tree.listeners.add(listener);
      return x;
   }
}
